Abstract Constructs a new instance of the CelCashServiceContract class.
Configure - The configuration object for the CelCash service.
LoggingInterface - The logger object for logging.
Private Readonly #cel_Private Readonly #cel_Private Readonly #cel_Private Readonly #configStatic Readonly CACHECache constants for CelCash service.
Readonly ACCESS_Readonly ROOT: "cel_cash"Gets the antecipation client.
The antecipation client.
Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the cards client.
The cards client.
Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional createdOptional createdOptional customerOptional customerOptional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc"Optional status?: "active" | "inactive" | ("active" | "inactive")[]// List cards
const cards = await service.cards.list({
query: {
limit: 10,
startAt: 0,
},
})
// Create a card
const card = await service.create({
body: {
//...
}
})
// Delete a card
const result = await service.delete({
params: {
cardId: 123,
typeId: 'galaxPayId'
}
})
Gets the chargebacks client.
The chargebacks client.
Gets the charges client.
The charges client.
Optional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional Address?: { Optional city?: stringOptional complement?: stringOptional neighborhood?: stringOptional number?: stringOptional state?: stringOptional street?: stringOptional zipOptional createdOptional document?: stringOptional emails?: string[]Optional galaOptional invoiceOptional municipalOptional myOptional name?: stringOptional phones?: number[]Optional status?: "active" | "inactive" | "delayed" | "withoutSubscriptionOrCharge"Optional updatedOptional PaymentOptional Aggrement?: { Optional document?: stringOptional name?: stringOptional deadlineOptional documentOptional fine?: numberOptional instructions?: stringOptional interest?: numberOptional PaymentOptional Antifraud?: { Optional Brand?: { Optional id?: stringOptional maxOptional name?: stringOptional operatorOptional createdOptional customerOptional customerOptional cvv?: stringOptional expiresOptional galaxOptional holder?: stringOptional myOptional number?: stringOptional updatedOptional cardOptional preOptional PaymentOptional Deadline?: { Optional type?: "days"Optional value?: numberOptional fine?: numberOptional instructions?: stringOptional interest?: numberOptional additionalOptional payedOptional planOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional createdOptional createdOptional customerOptional customerOptional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc"Optional status?: "active" | "inactive" | ("active" | "inactive")[]Optional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: { Optional valueOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional additionalOptional myOptional payday?: stringOptional payedOptional planOptional planOptional value?: numberOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the companies client.
The companies client.
Gets the customers client.
The customers client.
Optional complement?: stringOptional invoiceOptional municipalOptional phones?: number[]Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional createdOptional createdOptional createdOptional createdOptional documents?: string | string[]Optional emails?: string | string[]Optional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc" | "updatedAt.asc" | "updatedAt.desc"Optional startOptional status?: "active" | "inactive" | "delayed" | "withoutSubscriptionOrCharge"Optional complement?: stringOptional invoiceOptional municipalOptional phones?: number[]Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the pix client.
The pix client.
Optional desc?: stringOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the plans client.
The plans client.
Optional additionalOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional createdOptional createdOptional createdOptional createdOptional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc" | "updatedAt.asc" | "updatedAt.desc"Optional status?: "active" | "inactive"Optional body?: { Optional PlanOptional additionalOptional myOptional name?: stringOptional periodicity?: "weekly" | "biweekly" | "monthly" | "bimonthly" | "quarterly" | "biannual" | "yearly"Optional quantity?: numberOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the subscriptions client.
The subscriptions client.
Optional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional createdOptional createdOptional createdOptional createdOptional customerOptional customerOptional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc" | "updatedAt.asc" | "updatedAt.desc"Optional planOptional planOptional status?: "active" | "inactive" | "canceled" | "closed" | "stopped" | "waitingPayment"Gets the transactions client.
The transactions client.
Optional galaxOptional qtdOptional qtdOptional Antifraud?: { Optional Brand?: { Optional id?: stringOptional maxOptional name?: stringOptional operatorOptional createdOptional customerOptional customerOptional cvv?: stringOptional expiresOptional galaxOptional holder?: stringOptional myOptional number?: stringOptional updatedOptional cardOptional preOptional payday?: stringOptional payedOptional value?: numberOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional InvoiceOptional galaxOptional qtdOptional qtdOptional Antifraud?: { Optional Brand?: { Optional id?: stringOptional maxOptional name?: stringOptional operatorOptional createdOptional customerOptional customerOptional cvv?: stringOptional expiresOptional galaxOptional holder?: stringOptional myOptional number?: stringOptional updatedOptional cardOptional preOptional additionalOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional chargeOptional chargeOptional createdOptional createdOptional customerOptional customerOptional galaxOptional myOptional order?: "createdAt.asc" | "createdAt.desc" | "payday.asc" | "payday.desc"Optional payOptional payOptional status?: "cancel" | "noSend" | "authorized" | "captured" | "denied" | "reversed" | "chargeback" | "pendingBoleto" | "payedBoleto" | "notCompensated" | "lessValueBoleto" | "moreValueBoleto" | "paidDuplicityBoleto" | "pendingPix" | "payedPix" | "unavailablePix" | "payExternal" | "cancelByContract" | "free" | ("cancel" | "noSend" | "authorized" | "captured" | "denied" | "reversed" | "chargeback" | "pendingBoleto" | "payedBoleto" | "notCompensated" | "lessValueBoleto" | "moreValueBoleto" | "paidDuplicityBoleto" | "pendingPix" | "payedPix" | "unavailablePix" | "payExternal" | "cancelByContract" | "free")[]Optional subscriptionOptional updateOptional updateOptional body?: {}Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional body?: { Optional valueOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideOptional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overrideGets the transfer client.
The transfer client.
Optional cache?: anyUse fetchOptions.cache instead
Optional extraOptional fetchOptional overridePrivate #getProtected Abstract getProtected Abstract set
Abstract class representing the CelCash service contract.